API Reference Guide - MashupInfo Object
Overview
Mashup is essentially every media type supported by VIDIZMO. The list includes:
This document shall primarily help you understand Mashup object** and its various properties in VIDIZMO REST API Reference.
MashupInfo Object
{
// Primary key of mashup object in system. Used to uniquely identify mashup in system
"id": ,
// User profile of the user who created this record in system
"addedBy": , //Read: API%20Reference%20Guide%20-%20UserProfileInfo%20Object.md) can view the mashup
// When set to "ChannelUsers": Only current portal users can access this mashup
// When set to "ChannelUsersAndMainChannelUsers": Portal users and main portal users both can access mashup. This options only qualify for child portals. This is normally used when you have signed up for multiple portals and you are trying to share content of child portal with main account portal users.
"defaultViewingAccess": ,
// Current status of mashup
// When set to "Drafted": Mashup will not appear in library, and can only be seen through draft tab of media manager
// When set to "PendingForApproval": When mashup is awaiting moderation by the moderator
// When set to "Published": When mashup is in published state
// When set to "Rejected": When moderator has rejected mashup during moderation
// When set to "Purged": When mashup is purged after deletion. If mashup status is set to "Purged", it cannot be recovered back in portal
"status": ,
// True, if mashup is marked as featured
"isFeatured": ,
// Weight of featured mashup. It is used to sort mashups when featured mashups are requested. Mashups with higher weights will appear on top of featured mashups list.
"weight": ,
// Format of mashup like Audio, video, image document, collection, playlist, live, survey or quiz
"format": ,
// When true, a transcription control appears on right hand side of player on VIDIZMO portal playback page
"isTranscriptionEnabled": ,
// When true, it indicates whether this mashup is created by clipping some other mashup in system
"isClipping": ,
// Contains some stats about mashup. These stats are populated from raw tracking that our player generated from our portal playback page or from other website where player is generated using iFrame or JavaScript widgets
"mashupStats": {
"mashupId": ,
"tenantId": ,
"totalComments": ,
"totalFavorites": ,
"totalViews": ,
"totalLikes": ,
"totalDislikes": ,
"totalPoints": ,
"totalViewers": ,
"totalCompletions": ,
"totalImpressions": ,
"totalPlayTime": ,
"totalBuffers": ,
"totalErrors": ,
"totalFormAttempts": ,
"totalDownloads": ,
"totalShares": ,
"totalFeedbackImprovements": ,
"totalFeedbackIssues": ,
"totalFeedbackQuestions": ,
"totalFeedbackAbusive": ,
"totalFeedbackOthers": ,
"addedDateTime": ,
"lastUpdatedTime": ,
},
// This object is valid for authenticated users of portal and indicates what rating a user has given to this particular mashup. This object is personal for every user.
"myRating": {
"id": ,
"value": ,
// Type can be on of the following StarRating, LikeDislike
"type": ,
"subject": ,
"objectId": ,
"tenantId": ,
"isDeleted": ,
"userProfileId": ,
"addedDateTime": ,
"updatedOn":
},
// This object is valid for authenticated users of portal and indicates if a user has marked it as favorite. This object is personal for every user.
"myFavorite": {
"id": ,
"addedDateTime": ,
"userProfileId": ,
"tenantId":
},
// Provide list of all learning plans with which this mashup is associated
// More about this object can be read at: API%20Reference%20Guide%20-%20LearningPlanInfo%20Object.md) to load when a video reached a certain duration.
// quiz: Indicates which quiz (mashup) to load when a video reached a certain duration.
// handout: Indicates which handout (small files) to load when a video reached a certain duration.
// plugin: Indicates which custom plugin (hubspot or any other custom plugin written by the user) to load when a video reached a certain duration.
// drone: KLV data extracted from media files generated by drones are stored against this type
"timedData": , // Read more about the [object at:](../REST%20API%20Object%20Models/API%20Reference%20Guide%20-%20TimedDataInfo%20Object.md) product package.
// Different flags for player
"player": {
// This will contain encrypted password if mashup is password protected
"passCode": <string>,
// If true, a control on right hand side of player will appear which will show timed data
"displayTimedData": <boolean>,
// If true, player will render video in 360 mode. We do not capture 360 mode from within video so uploader will have to set it manually
"isVideo360": <boolean>,
// This criteria indicates at which position we should consider video as complete. Once this criteria is met in playback page, player will track complete event and video wille be considered completed
"completionCriteria":{
// Property to compare. Right now only "Marker" is supported.
"property": <string>,
// Criteria to match. Right now only "Equal To" is supported.
"criteria": <string>,
// Value in percentages on the scale of 1-100. If set to 89, when video reaches at 89% a complete event will be raised.
"criteriaValue": <number>
},
// Template for VIDIZMO player to render itself from this template
"playerTemplateDetail": <PlayerTemplateDetailInfo> // Read more about the object [at](../REST%20API%20Object%20Models/API%20Reference%20Guide%20-%20PlayerTemplateInfo%20Object.md):
}
// Contains flags for mashup player to render itself
"participation": {
"commentEnabled": <boolean>,
"commentModerationRequired": <boolean>,
"isMashupStatsEnabled": <boolean>,
"isDownload": <boolean>,
"isEmbed": <boolean>,
"isSocialSharing": <boolean>
},
// Include live chat contract here
"liveChat": <liveChatInfo>, // Read more about the object [at](../REST%20API%20Object%20Models/API%20Reference%20Guide%20-%20LiveChatInfo%20Object.md):
// Include live chat contract here
"liveQnA": <liveQnAInfo>,
// If mashup is drm protected, include details about it here
"drmInfo": {
// DRM provider like AMS, VIDIZMO
"drmProvider": <string>,
"drmOptions":{
// Below given properties are valid for DRM type
// PlayReady, Widevine, FairPlay or Cenc
"drmType": <string>,
// Fully qualified HTTP url through which to obtain license
"licenseUrl": <string>,
// Authorization token that can be used to obtain license from license url
"authToken": <string>
},
// UTC date and time of license start
"From": <utcDateAndTime>,
// UTC date and time of license end
"End": <utcDateAndTime>,
// Boolean value indicating whther license is persistence license or not
"Persistent": <boolean>,
"ContentKeyId": <string>,
"AssetDeliveryPolicyId": <string>,
"AuthorizationPolicyId": <string>
},
// All insights that are captured for this mashup
"insight": <insightInfo>, // Read more about the object [at](../REST%20API%20Object%20Models/API%20Reference%20Guide%20-%20InsightInfo%20Object.md)
// Status of moderation of this mashup. This object is only return when moderation policy asks users to have multiple moderators and one of those moderators moderated it.
"mashupModerations": [
{
"id": <number>,
"mashupId": <number>,
"userProfileId": <number>,
"moderatorName": <string>,
"mashupStatus": <string>
}
],
// Contains checksum data for all physical files of this mashup. This object is compared with a newly generated content checksum property to indicate tamper.
"contentsCheckSum": [
{
"fileName": <string>,
"checkSum": <string>
}
],
// Tamper status of current mashup
"tamperStatus": <string>,
// On which particular date tamper was identified in mashup
"verifiedTamperOn": <utcDateAndTime>
}